cs-notifications-papi
📘 API Documentation - CS Notifications PAPI
This section describes the attributes and usage of the cs-notifications-papi, version 1.0.0. It is a Process API to send SMS and Email messages.
💂️ Base Information
- API Title: cs-notifications-papi
- Version: 1.0.0
- Base URL:
https://cs-notifications-papi.cloudhub.io/
🔑 Authentication
Required Headers
| Header | Type | Description |
|---|---|---|
| Authorization | String | Bearer token in the format Bearer {{API_KEY}} |
| client_id | String | Unique identifier for API clients |
📌 These headers are required in all requests.
✨ Endpoints
📧 Send Email
POST /email
- Description: Sends email messages with optional file attachments or base64-encoded content.
Body Parameters (multipart/form-data)
| Parameter | Type | Required | Description |
|---|---|---|---|
| files | file[] | ❌ | File(s) to be uploaded |
| body | object | ✅ | Email details (recipients, subject, etc.) |
| base64 | string | ❌ | Base64 encoded PDF |
📎 Example: examples/request/post-send-email.json
📎 Response Example: examples/response/post-send-email.raml
🔍 Track Email Notifications
GET /email/notification-track
- Description: Retrieves tracking details for emails sent using the notification-track account.
Query Parameters
| Parameter | Type | Example | Required | Description |
|---|---|---|---|---|
| filter | String | {"mail_to":"juan.garcia@correo.com"} | ❌ | Filter criteria for email tracking |
📎 Example: examples/response/get-email-notification-track.json
📩 Send SMS
POST /sms
- Description: Sends SMS messages through the default provider.
📎 Request Example: examples/request/post-send-sms.raml
📎 Response Example: examples/response/post-send-sms.raml
📡 Send SMS via Twilio
POST /twilio/sms
- Description: Sends SMS messages through Twilio.
📎 Request Example: examples/request/post-send-sms-twilio.json
📎 Response Example: examples/response/post-send-sms-twilio.json
🔎 Track Email Notifications (v2)
GET /v2/email/notification-track
- Description: Retrieves tracking details with provider and account filters.
Query Parameters
| Parameter | Type | Example | Required | Description |
|---|---|---|---|---|
| providerId | String | 10225e9b-87ed-4875-a959-6835061cbc97 | ❌ | Email provider ID |
| accountId | String | 8e109488-4617-40ca-b67c-efcb83d566f2 | ❌ | Email account ID |
| filter | String | {"mail_to":"juan.garcia@correo.com"} | ❌ | Filter criteria |
📎 Example: examples/response/get-email-notification-track.json
🔐 Security Schemes
Client ID Enforcement
| Field | Type | Required | Length | Regex |
|---|---|---|---|---|
| client_id | String | Yes | 32 - 36 | [a-zA-Z0-9] |
OAuth 2.0
| Field | Type | Required | Length | Regex |
|---|---|---|---|---|
| Authorization | String | Yes | 36 - 37 | [a-zA-Z0-9-_.] |
⚠️ Error Codes
| Code | Description | Suggested Solution |
|---|---|---|
| 400 | Bad Request | Check input data and format. |
| 401 | Unauthorized | Verify authentication credentials. |
| 404 | Not Found | Requested resource not found. |
| 500 | Internal Server Error | Retry or contact technical support. |
📞 Support
For assistance, contact the Integration Services and Applications Coordination team.
Email: epalma@fg
Last updated: April 2025